SureTax DRC API
Get Form Instance Download URL
Overview
This API endpoint provides clients with the download URL for accessing a specific form instance. A unique URL is generated for restricted access. The URL includes necessary authentication data, ensuring secure access to the form instance and contains expiration time to enhance security.
OperationId: Get Form Instance Download URL
Authorization Method(s): OAuth
Verb: GET
End Point: /api/Forms/FormInstanceDownloadURL
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Id* | Id | string |
Overview
Response object for GET requests that provide download URLs for specific form instances.
Example Response
The following is an example response you can expect for this operation
{
"data": {
"formInstances": [
{
"id": "68962b44-579b-4477-82e5-4b92ae30ce31",
"downloadUrl": "https://sandboxsuretaxzar.taxrating.net/downloads/7330d7b3-ae00-4c9c-b332-5564280dcb09/TX_01-114_%24webSales_Mar_2024_20240312184655.pdf?sv=2021-10-04\u0026se=2024-06-03T16%3A57%3A07Z\u0026sr=b\u0026sp=r\u0026rscc=max-age%3D0\u0026sig=Rz5lUabVrGgvdJrjj7OG1RTAHALC6SW%2B3IMAyzKf38k%3D"
}
]
}
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains a list of form instances with their download URLs. |
| 204 | 204 No Content If no records are found for the provided request, the API will respond with a No Content status. |
| 400 | Bad request. Invalid data provided. |
| 401 | Unauthorized access. |
| 500 | Internal server error. |